Crate ron[][src]

Expand description

RON is a simple config format which looks similar to Rust syntax.

Features

  • Data types
    • Structs, typename optional
    • Tuples
    • Enums
    • Lists
    • Maps
    • Units (())
    • Optionals
    • Primitives: booleans, numbers, string, char
  • Allows nested layout (similar to JSON)
  • Supports comments
  • Trailing commas
  • Pretty serialization

Syntax example

Game(
    title: "Hello, RON!",
    level: Level( // We could just leave the `Level` out
        buildings: [
            (
                size: (10, 20),
                color: Yellow, // This as an enum variant
                owner: None,
            ),
            (
                size: (20, 25),
                color: Custom(0.1, 0.8, 1.0),
                owner: Some("guy"),
            ),
        ],
        characters: {
            "guy": (
                friendly: true,
            ),
        },
    ),
)

Usage

Just add it to your Cargo.toml:

[dependencies]
ron = "*"

Serializing / Deserializing is as simple as calling to_string / from_str.

Re-exports

pub use de::from_str;
pub use de::Deserializer;
pub use error::Error;
pub use error::Result;
pub use ser::to_string;
pub use ser::Serializer;
pub use value::Map;
pub use value::Number;
pub use value::Value;

Modules